/*
 * $RCSfile: ChannelImageOutputStreamSpi.java,v $
 *
 * 
 * Copyright (c) 2005 Sun Microsystems, Inc. All  Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met: 
 * 
 * - Redistribution of source code must retain the above copyright 
 *   notice, this  list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in 
 *   the documentation and/or other materials provided with the
 *   distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of 
 * contributors may be used to endorse or promote products derived 
 * from this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any 
 * kind. ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND 
 * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, 
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY
 * EXCLUDED. SUN MIDROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL 
 * NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF 
 * USING, MODIFYING OR DISTRIBUTING THIS SOFTWARE OR ITS
 * DERIVATIVES. IN NO EVENT WILL SUN OR ITS LICENSORS BE LIABLE FOR 
 * ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT, SPECIAL,
 * CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER CAUSED AND
 * REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
 * INABILITY TO USE THIS SOFTWARE, EVEN IF SUN HAS BEEN ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES. 
 * 
 * You acknowledge that this software is not designed or intended for 
 * use in the design, construction, operation or maintenance of any 
 * nuclear facility. 
 *
 * $Revision: 1.1 $
 * $Date: 2005/02/11 05:01:53 $
 * $State: Exp $
 */
package com.github.jaiimageio.impl.stream;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.channels.Channels;
import java.nio.channels.FileChannel;
import java.nio.channels.NonReadableChannelException;
import java.nio.channels.WritableByteChannel;
import java.util.Locale;

import javax.imageio.spi.ImageOutputStreamSpi;
import javax.imageio.stream.FileCacheImageOutputStream;
import javax.imageio.stream.ImageOutputStream;
import javax.imageio.stream.MemoryCacheImageOutputStream;

import com.github.jaiimageio.impl.common.PackageUtil;
import com.github.jaiimageio.stream.FileChannelImageOutputStream;

public class ChannelImageOutputStreamSpi extends ImageOutputStreamSpi {
    public ChannelImageOutputStreamSpi() {
        super(PackageUtil.getVendor(),
              PackageUtil.getVersion(),
	      WritableByteChannel.class);
    }

    public ImageOutputStream createOutputStreamInstance(Object output,
							boolean useCache,
							File cacheDir)
	throws IOException {

	if(output == null ||
	   !(output instanceof WritableByteChannel)) {
	    throw new IllegalArgumentException
                ("Cannot create ImageOutputStream from "+
                 output.getClass().getName());
	}

	ImageOutputStream stream = null;

	if(output instanceof FileChannel) {
            FileChannel channel = (FileChannel)output;
            try {
                // The Channel must be readable.
                channel.map(FileChannel.MapMode.READ_ONLY,
                            channel.position(),
                            1);
                stream = new FileChannelImageOutputStream((FileChannel)output);
            } catch(NonReadableChannelException nrce) {
                // Ignore it.
            }
        }

        if(stream == null) {
	    OutputStream outStream =
		Channels.newOutputStream((WritableByteChannel)output);

	    if(useCache) {
		try {
		    stream = new FileCacheImageOutputStream(outStream,
							    cacheDir);
		} catch(IOException e) {
		    // Cache file could not be created.
		}
	    }

	    if(stream == null) {
		stream = new MemoryCacheImageOutputStream(outStream);
	    }
	}

	return stream;
    }

    public String getDescription(Locale locale) {
	return "NIO Channel ImageOutputStream";
    }
}
